Python: fix(google-ai): skip api_key check when use_vertexai is True by giulio-leone · Pull Request #13607 · microsoft/semantic-kernel

giulio-leone · 2026-02-28T12:34:19Z

Summary

Motivation and Context

When use_vertexai=True, users authenticate via Application Default Credentials (ADC) and don't need an API key. However, the initialization check for api_key runs unconditionally, blocking Vertex AI users with:

ServiceInitializationError: The API key is required when use_vertexai is False.

Description

Guard the api_key validation with not google_ai_settings.use_vertexai in all three Google AI service classes:

GoogleAIChatCompletion
GoogleAITextCompletion
GoogleAITextEmbedding

The error message already reads "when use_vertexai is False", so the condition now matches the intent.

Before / After

# Before — fails even with use_vertexai=True
GoogleAIChatCompletion(
    use_vertexai=True,
    cloud_project_id="my-project",
    cloud_region="us-central1"
)
# → ServiceInitializationError: The API key is required when use_vertexai is False.

# After — works correctly
GoogleAIChatCompletion(
    use_vertexai=True,
    cloud_project_id="my-project",
    cloud_region="us-central1"
)
# → Initializes successfully, uses ADC for authentication

Contribution Checklist

The code builds clean without any errors or warnings
The PR follows the SK Contribution Guidelines
The code follows the SK coding standards

giulio-leone · 2026-02-28T13:19:39Z

@microsoft-github-policy-service agree

giulio-leone · 2026-02-28T21:33:02Z

Friendly ping — CI is green and this is ready for review. Happy to address any feedback. Thanks!

Copilot

Pull request overview

This PR fixes Google AI connector initialization for Vertex AI usage by skipping the api_key requirement when use_vertexai=True, aligning the validation logic with the intended ADC authentication path.

Changes:

Guard api_key validation with not use_vertexai in GoogleAIChatCompletion.
Guard api_key validation with not use_vertexai in GoogleAITextCompletion.
Guard api_key validation with not use_vertexai in GoogleAITextEmbedding.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_chat_completion.py	Skip API key validation when using Vertex AI during initialization.
python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py	Skip API key validation when using Vertex AI during initialization.
python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_embedding.py	Skip API key validation when using Vertex AI during initialization.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_chat_completion.py

python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py

python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_embedding.py

giulio-leone · 2026-03-06T02:38:13Z

Hi! Gentle ping — this PR is rebased, CI passes, and ready for review. Happy to address any feedback. Thanks!

giulio-leone · 2026-03-09T15:36:20Z

Friendly ping — CI is green, tests pass, ready for review whenever convenient. Happy to address any feedback. Thanks! 🙏

giulio-leone · 2026-03-12T21:47:29Z

Hi — all 4 threads resolved. cloud_region validation added to all 3 service classes. Fixes #13483. Ready for review!

giulio-leone · 2026-03-19T11:40:05Z

Rebased this branch onto current main (bb421f67a, PR #13686) and reran local validation twice with no code changes between passes.

Local validation (Pass 1 and Pass 2)

UV_PYTHON=3.10 uv run --frozen ruff check semantic_kernel/connectors/ai/google/google_ai/services/google_ai_chat_completion.py semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_embedding.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_chat_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_embedding.py
- both passes: All checks passed!
UV_PYTHON=3.10 uv run --frozen pytest tests/unit/connectors/ai/google/google_ai/services/test_google_ai_chat_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_embedding.py
- both passes: 53 passed

Direct runtime proof (real source files, not mocks)

Using the real origin/main source tree vs this rebased branch with:

GOOGLE_AI_GEMINI_MODEL_ID=test-gemini-model-id
GOOGLE_AI_EMBEDDING_MODEL_ID=test-embedding-model-id
GOOGLE_AI_CLOUD_PROJECT_ID=test-project-id
GOOGLE_AI_CLOUD_REGION=test-region
no GOOGLE_AI_API_KEY

Results were identical across both proof passes:

Case	Chat	Text	Embedding
`origin/main` + `use_vertexai=True` + no `api_key`	`ServiceInitializationError: The API key is required when use_vertexai is False.`	same	same
PR branch + `use_vertexai=True` + no `api_key`	initializes successfully	initializes successfully	initializes successfully
PR branch + `use_vertexai=True` + missing `cloud_region`	`ServiceInitializationError: Region must be provided when use_vertexai is True.`	same	same

So the rebased PR still fixes the original bug on all 3 Google AI service initializers while preserving the new cloud_region validation path.

moonbox3 · 2026-03-19T11:47:08Z

Just need the CI/CD checks to pass and we'll get this merged. We will monitor.

giulio-leone · 2026-03-21T00:46:39Z

Rebased this branch onto the current main (0e2e6bd77) and reran the local gate twice from the rebased head 8ba149c9c with no code changes between passes.

Local validation (Pass 1 and Pass 2)

UV_PYTHON=3.10 uv run --frozen --extra google --extra pandas ruff check semantic_kernel/connectors/ai/google/google_ai/services/google_ai_chat_completion.py semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_embedding.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_chat_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_embedding.py
- both passes: All checks passed!
UV_PYTHON=3.10 uv run --frozen --extra google --extra pandas pytest tests/unit/connectors/ai/google/google_ai/services/test_google_ai_chat_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_completion.py tests/unit/connectors/ai/google/google_ai/services/test_google_ai_text_embedding.py -q
- both passes: 53 passed

Direct runtime proof against current `main`

Using the real source trees with:

GOOGLE_AI_GEMINI_MODEL_ID=test-gemini-model-id
GOOGLE_AI_EMBEDDING_MODEL_ID=test-embedding-model-id
GOOGLE_AI_CLOUD_PROJECT_ID=test-project-id
GOOGLE_AI_CLOUD_REGION=test-region
no GOOGLE_AI_API_KEY

Results were identical across both proof passes:

Case	Chat	Text	Embedding
current `main` + `use_vertexai=True` + no `api_key`	`ServiceInitializationError: The API key is required when use_vertexai is False.`	same	same
rebased PR branch + `use_vertexai=True` + no `api_key`	initializes successfully	initializes successfully	initializes successfully
rebased PR branch + `use_vertexai=True` + missing `cloud_region`	`ServiceInitializationError: Region must be provided when use_vertexai is True.`	same	same

So after rebasing onto the latest main, this PR still fixes the original Vertex AI initialization bug on all three Google AI service initializers while preserving the fast-fail cloud_region validation path.

giulio-leone · 2026-03-21T00:52:27Z

Small status note on the refreshed head 8ba149c9c: local validation is in the comment above and GitHub has created fresh workflow runs for the new SHA, but the main workflows are currently showing action_required with zero jobs attached on this fork-based refresh.

If that is just the usual maintainer approval step for fork workflows, that looks like the remaining blocker on the new head. If not, I am happy to investigate further from my side.

giulio-leone requested a review from a team as a code owner February 28, 2026 12:34

moonbox3 added the python Pull requests for the Python Semantic Kernel label Feb 28, 2026

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch from 27f8e4d to ce250e0 Compare February 28, 2026 14:51

Copilot AI review requested due to automatic review settings March 4, 2026 04:29

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch from ce250e0 to 3814db8 Compare March 4, 2026 04:29

Copilot started reviewing on behalf of giulio-leone March 4, 2026 04:30 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch 2 times, most recently from d8cb434 to 56c3e4c Compare March 9, 2026 14:12

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch from 56c3e4c to 2bf8b08 Compare March 9, 2026 18:43

moonbox3 approved these changes Mar 19, 2026

View reviewed changes

eavanvalkenburg approved these changes Mar 19, 2026

View reviewed changes

eavanvalkenburg enabled auto-merge March 19, 2026 11:20

auto-merge was automatically disabled March 19, 2026 11:39
Head branch was pushed to by a user without write access

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch from 77e740d to a6aa391 Compare March 19, 2026 11:39

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch from a6aa391 to 083fafc Compare March 19, 2026 11:43

moonbox3 approved these changes Mar 19, 2026

View reviewed changes

moonbox3 enabled auto-merge March 19, 2026 11:46

moonbox3 added this pull request to the merge queue Mar 19, 2026

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 19, 2026

giulio-leone and others added 2 commits March 21, 2026 01:42

Python: fix(google-ai): skip api_key check when use_vertexai is True

df13d9f

fix: add vertexai parameter validation and tests

8ba149c

giulio-leone force-pushed the fix/issue-13483-google-ai-vertexai-api-key branch from 083fafc to 8ba149c Compare March 21, 2026 00:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Python: fix(google-ai): skip api_key check when use_vertexai is True#13607

Python: fix(google-ai): skip api_key check when use_vertexai is True#13607
giulio-leone wants to merge 2 commits intomicrosoft:mainfrom
giulio-leone:fix/issue-13483-google-ai-vertexai-api-key

giulio-leone commented Feb 28, 2026

Uh oh!

giulio-leone commented Feb 28, 2026

Uh oh!

giulio-leone commented Feb 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

giulio-leone commented Mar 6, 2026

Uh oh!

giulio-leone commented Mar 9, 2026

Uh oh!

giulio-leone commented Mar 12, 2026

Uh oh!

giulio-leone commented Mar 19, 2026 •

edited

Loading

Uh oh!

moonbox3 commented Mar 19, 2026

Uh oh!

Uh oh!

giulio-leone commented Mar 21, 2026

Uh oh!

giulio-leone commented Mar 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

giulio-leone commented Feb 28, 2026

Summary

Motivation and Context

Description

Before / After

Contribution Checklist

Uh oh!

giulio-leone commented Feb 28, 2026

Uh oh!

giulio-leone commented Feb 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

giulio-leone commented Mar 6, 2026

Uh oh!

giulio-leone commented Mar 9, 2026

Uh oh!

giulio-leone commented Mar 12, 2026

Uh oh!

giulio-leone commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Local validation (Pass 1 and Pass 2)

Direct runtime proof (real source files, not mocks)

Uh oh!

moonbox3 commented Mar 19, 2026

Uh oh!

Uh oh!

giulio-leone commented Mar 21, 2026

Local validation (Pass 1 and Pass 2)

Direct runtime proof against current main

Uh oh!

giulio-leone commented Mar 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

giulio-leone commented Mar 19, 2026 •

edited

Loading

Direct runtime proof against current `main`